home *** CD-ROM | disk | FTP | other *** search
/ Disc to the Future 2 / Disc to the Future Part II Programmer's Reference (Wayzata Technology)(6013)(1992).bin / MAC / LISP / AUTOCLAS / DOC / REPORTS.TEX (.txt) < prev    next >
LaTeX Document  |  1990-07-17  |  7KB  |  119 lines
  1. ; -*- Mode: text -*-
  2. ;;; File:  AutoClass:doc;reports.text
  3. ;;;--------------------------------------------------------------------------;;;
  4. ;;;  AUTOCLASS 3.0  Released 5/11/90    contact:  Taylor@pluto.arc.nasa.gov  ;;;
  5. ;;;  by P. Cheeseman, J. Stutz, R. Hanson, W. Taylor                  ;;;
  6. ;;;  NASA Ames Research Center, MS 244-17, Moffett Field, CA 94035           ;;;
  7. ;;;                                                                          ;;;
  8. ;;;  Copyright (C) 1990 Research Institute for Advanced Computer Science.    ;;;
  9. ;;;  All rights reserved.  The RIACS Software Policy contains specific       ;;;
  10. ;;;  terms and conditions on the use of this software, and must be           ;;;
  11. ;;;  distributed with any copies.  THIS FILE MAY BE REDISTRIBUTED.  This     ;;;
  12. ;;;  copyright and notice must be preserved in all copies made of this file. ;;;
  13. ;;;--------------------------------------------------------------------------;;;
  14.             GENERATING REPORTS
  15. You are provided two functions for outputting the three standard reports from the
  16. results generated by AUTOCLASS-SEARCH. The functions are 
  17. AUTOCLASS-REPORTS-FROM-CLSF and AUTOCLASS-REPORTS-FROM-RESULTS-FILE. The 
  18. standard reports are 
  19.     1) attribute influence values: presents the relative influence or 
  20.        significance of the data's attributes both globally (averaged over
  21.        all classes), and locally (specifically for each class). A heuristic
  22.        for relative class strength is also listed;
  23.     2) cross-reference by case (datum) number: lists the primary class 
  24.        probability for each datum, ordered by case number;
  25.     3) cross-reference by class number: for each class the primary class
  26.        probability and any lesser class probabilities (greater than 0.10)
  27.        are listed for each datum in the class, ordered by case number. It
  28.        is also possible to list, for each datum, the values of attributes, 
  29.        which you select.
  30. The attribute influence values report attempts to provide relative measures of
  31. the "influence" of the data attributes on the classes found by the classification.
  32. The normalized class strengths, the normalized attribute influence values summed
  33. over all classes, and the individual influence values (I[jkl]) are all only 
  34. relative measures and should be interpreted with more meaning than rank ordering,
  35. but not like anything approaching absolute values.
  36. The reports are output to files whose pathnames are "merged" onto that of the
  37. results-file argument (in the case of AUTOCLASS-REPORTS-FROM-RESULTS-FILE), 
  38. for example --
  39.     (autoclass-reports-from-results-file
  40.       "autoclass-x:>data>soybean>soy&soy&soy" .... )
  41. or the pathname of :stream-or-reports-pathname (in the case of                     
  42. AUTOCLASS-REPORTS-FROM-CLSF, when its value is a pathname), for example --
  43.     (autoclass-reports-from-clsf <clsf>
  44.       "autoclass-x:>data>soybean>soy&soy&soy" ..... 
  45. produces
  46.     "autoclass-x:>data>soybean>soy&soy&soy.influ-text" , etc.
  47. The report file types (extensions) are:
  48.     influence values report:  "influ-text"  & "influ-data"
  49.     cross-reference by case:  "case-text"   & "case-data"
  50.     cross-reference by class: "class-text"  & "class-data"
  51. The report generator functions, by default (:report-type :text) produce 
  52. formatted reports (file type of "xxxx-text"). However, with :report-type 
  53. specified as :data or :both, they will produce list data structures of the 
  54. appropriate information, such that you can write individually tailored
  55. report formatters (file type of "xxxx-data"). Both these functions return
  56. the classification structure.
  57. The input argument list of AUTOCLASS-REPORTS-FROM-CLSF is:
  58.     (clsf stream-or-reports-pathname
  59.      &key (report-type :all)
  60.           (report-mode :text) (package *ac-pkg*)
  61.           (num-atts-to-list :all) (results-file "")
  62.               (xref-class-report-att-list '())
  63.           (i-v-header-label-fcn #'influence-values-header-label)
  64.           (title-font-fcn #'default-title-font-fcn) .. )
  65. The required arguments are: 
  66. :CLSF, a classification structure (type classification-$) which is contained
  67.     in the second return value of AUTOCLASS-SEARCH (the vector of best
  68.     classifications); and 
  69. :STREAM-OR-REPORTS-PATHNAME, which can be an output stream (e.g. 
  70.     *standard-output*) or a fully qualified pathname.
  71. The :REPORT-TYPE keyword argument can be any one of:
  72.     value        influence values   xref by case   xref by class
  73.     -----        ----------------   ------------   -------------
  74.     :all            x        x        x     
  75.     :influence-values        x
  76.     :xref-case                    x
  77.     :xref-class                            x
  78.     :influ&x-case        x        x
  79.     :influ&x-class        x                x
  80.     :x-case&x-class                x        x
  81. Other keyword arguments are:
  82. :REPORT-MODE, which can be :both, :text, or :data;
  83. :NUM-ATTS-TO-LIST, which should be an integer number of attributes to list in
  84.     the influence value report (the default is :all); 
  85. :RESULTS-FILE, used to document the results file with which this classification
  86.     is associated (its existence is verified by the program); 
  87. :XREF-CLASS-REPORT-ATT-LIST, a list of attribute numbers, which will cause 
  88.     their values to be output along with the case numbers in the cross-
  89.     reference by class output (see sample report); and 
  90. :I-V-HEADER-LABEL-FCN & :TITLE-FONT-FCN, which allow you to write your own host
  91.     specific functions for the influence value report header labels and the
  92.     titles for all reports.
  93. The input argument list of AUTOCLASS-REPORTS-FROM-RESULTS-FILE is:
  94.     (results-file 
  95.      &key (report-type :all) (report-mode :text)
  96.           (reports-pathname :results-file)
  97.           (num-atts-to-list :all) (package *ac-pkg*)
  98.           (xref-class-report-att-list '())
  99.           (i-v-header-label-fcn #'influence-values-header-label)
  100.           (title-font-fcn #'default-title-font-fcn) ... )
  101. The only required argument is RESULTS-FILE, the fully qualified pathname of the
  102. results file, but without a file type since the program will determine for you 
  103. whether the file type is "results" (*clsf-ASCII-results-file-type*) or "dump"
  104. (*clsf-compiled-dump-file-type*).
  105. A new keyword argument, not already presented is :REPORTS-PATHNAME, which allows
  106. you the option of directing the report output to a specified pathname of your 
  107. choice. 
  108. See sample reports in directory ....>autoclass>sample>:    
  109.                                                                  
  110.     "imports-85&imports-85&imports-85.influ-text"
  111.     "imports-85&imports-85&imports-85.case-text"
  112.     "imports-85&imports-85&imports-85.class-text"
  113. which were generated by the form:
  114.     (autoclass-reports-from-results-file
  115.         "<host>: .... >autoclass>sample>imports-85&imports-85&imports-85"     
  116.         :xref-class-report-att-list '(2 5 6))
  117. -------------------------------------------------------------------------------
  118. -------------------------------------------------------------------------------
  119.